BaseItem Class Reference

An item that can be held in a Container. More...

Inheritance diagram for BaseItem:

Public Types
enum	ItemCategory {   Auto = 0, Weapon, HeadArmor, TorsoArmor,   LegArmor, Outfit, Accessory, Ammo,   Consumable, Mod, Misc }

Public Member Functions
void	Register ()
	Registers the BaseItem so that it is active and enabled during gameplay.

Public Attributes
string	itemTags = ""
	The tags that describe the item. These are used primarily to determine item spawn lists.
string	itemName
	The name of the item.
string	itemDescription
	A description of the item's properties.
string	itemFlavorText
	A short piece of text that describes the lore of the item.
ItemCategory	category
	The category the item falls under.
int	price = 0
	The TP price of the item.
bool	isUnique = false
	Whether the item is unique. Unique items are reclaimed by the Ony Express. Should not be used with items that are part of spawn lists.
bool	pooled = false
	Is the item stackable.
List< ItemUseRestriction >	usageRestrictions
	A list of restrictions on the item's usage.
bool	dontScaleWeightWithRoomDifficulty = false
	A flag preventing the item's spawn weight from being modified by the room difficulty.
float	defaultItemLevel = 0.0F
	The default level of the item. Roughly speaking, the floor at which the item spawns.
float	defaultItemWeight = 1.0F
	How often the item spawns. Greater values means the item is more likely to spawn compared to other items.
List< DungeonSpawnWeight >	dungeonSpawnWeights = new List<DungeonSpawnWeight>()
	A list of spawn weight overrides that override the default values.
int	minLootAmount = 1
	The minimum number of items to spawn every time this item is selected to spawn in a loot roll.
int	maxLootAmount = 1
	The maximum number of items to spawn every time this item is selected to spawn in a loot roll.
List< string >	requiredKeys = new List<string>()
	A list of flags that must be present for the item to be considered in spawn lists.
int	stackCapacity = -1
	The amount of items that can be put into one stack of the item.
AudioClip	useSound
	The sound that is played when the item is activated.
AudioClip	moveSound
	The sounjd that is played when the item is moved/looted.
GameObject	itemModel
	The item's 3D model when dropped/placed in the world.

Detailed Description

An item that can be held in a Container.

---

The documentation for this class was generated from the following file:

• Items/BaseItem.cs